Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
CMgntAccessSettingManager Class Reference

CMgntAccessSettingManager is the asa object storage manager class that is used to store and retrieve asa object. More...

Public Member Functions

bool deleteIpv4MgntAccessSetting (AccessProtocol, ip, ip, string)
 Delete the access configuration that matches protocol, allowed ip address, allowed mask and nameIf. More...
 
bool deleteIpv6MgntAccessSetting (AccessProtocol, ip, int, string)
 Delete the access configuration that matches protocol, allowed ip address, allowed prefix and nameIf. More...
 
bool addMgntAccessSetting (AccessProtocol, ip, ip, string)
 Add the access configuration that matches protocol, allowed ip address, allowed mask and nameIf. More...
 
CMgntAccessSetting getMgntAccessSettingAt (int)
 Returns the access setting a specified index. More...
 
int getMgntAccessSettingCount ()
 Return the number of access setting. More...
 
void setSshTimeout (int)
 Set the ssh timeout for ssh connection. More...
 
int getSshTimeout ()
 Return the ssh timeout. More...
 
void setTelnetTimeout (int)
 Set the telnet timeout for telnet connection. More...
 
int getTelnetTimeout ()
 Return the Telnet timeout. More...
 
bool allow (AccessProtocol, ip, string)
 Check to see if the traffic that matches protocol, ipAddress into srcNameIf allowed or not. More...
 

Detailed Description

CMgntAccessSettingManager is the asa object storage manager class that is used to store and retrieve asa object.

Member Function Documentation

◆ addMgntAccessSetting()

bool CMgntAccessSettingManager::addMgntAccessSetting ( AccessProtocol  ,
ip  ,
ip  ,
string   
)

Add the access configuration that matches protocol, allowed ip address, allowed mask and nameIf.

Parameters
protocol,ssh/telnet/http
allowedIp,ipaddress
allowedMask,mask
srcNameIf,nameIfof the interface that allow remote access
Returns
bool, value is true if the add was successful, false if not.

◆ allow()

bool CMgntAccessSettingManager::allow ( AccessProtocol  ,
ip  ,
string   
)

Check to see if the traffic that matches protocol, ipAddress into srcNameIf allowed or not.

Parameters
protocol,ssh/telnet/http
ipAddress,sourceip address of the host
srcNameIf,thenameif of the interface in which the host is trying to gain access into
Returns
bool, value is true if the traffic that matches protocol, ipAddress into srcNameIf allowed, false if not.

◆ deleteIpv4MgntAccessSetting()

bool CMgntAccessSettingManager::deleteIpv4MgntAccessSetting ( AccessProtocol  ,
ip  ,
ip  ,
string   
)

Delete the access configuration that matches protocol, allowed ip address, allowed mask and nameIf.

Parameters
protocol,ssh/telnet/http
allowedIp,ipaddress
allowedMask,mask
srcNameIf,nameIfof the interface that allow remote access
Returns
bool, value is true if the delete was successful, false if not.

◆ deleteIpv6MgntAccessSetting()

bool CMgntAccessSettingManager::deleteIpv6MgntAccessSetting ( AccessProtocol  ,
ip  ,
int  ,
string   
)

Delete the access configuration that matches protocol, allowed ip address, allowed prefix and nameIf.

Parameters
protocol,ssh/telnet/http
allowedIp,ipaddress
allowedPrefix,ipv6prefix
srcNameIf,nameIfof the interface that allow remote access
Returns
bool, value is true if the delete was successful, false if not.

◆ getMgntAccessSettingAt()

CMgntAccessSetting CMgntAccessSettingManager::getMgntAccessSettingAt ( int  )

Returns the access setting a specified index.

Parameters
index,indexto retrive the access setting from. Range (0, getMgntAccessSettingCount()).
Returns
CMgntAccessSetting, value is the access setting a specified index.

◆ getMgntAccessSettingCount()

int CMgntAccessSettingManager::getMgntAccessSettingCount ( )

Return the number of access setting.

Returns
int, value is the number of access settings.

◆ getSshTimeout()

int CMgntAccessSettingManager::getSshTimeout ( )

Return the ssh timeout.

Returns
int, value is the ssh timeout.

◆ getTelnetTimeout()

int CMgntAccessSettingManager::getTelnetTimeout ( )

Return the Telnet timeout.

Returns
int, value is the Telnet timeout.

◆ setSshTimeout()

void CMgntAccessSettingManager::setSshTimeout ( int  )

Set the ssh timeout for ssh connection.

Parameters
timeout,inminutes

◆ setTelnetTimeout()

void CMgntAccessSettingManager::setTelnetTimeout ( int  )

Set the telnet timeout for telnet connection.

Parameters
timeout,inminutes

The documentation for this class was generated from the following file: